Int

class Int : Number, Comparable<Int>

Represents a 32-bit signed integer.

Types

Companion
Link copied to clipboard
object Companion

Functions

and
Link copied to clipboard
infix external fun and(other: Int): Int

Performs a bitwise AND operation between the two values.

compareTo
Link copied to clipboard
inline operator fun compareTo(other: Byte): Int
inline operator fun compareTo(other: Double): Int
inline operator fun compareTo(other: Float): Int
open operator external override fun compareTo(other: Int): Int
inline operator fun compareTo(other: Long): Int
inline operator fun compareTo(other: Short): Int

Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.

dec
Link copied to clipboard
operator external fun dec(): Int

Decrements this value.

div
Link copied to clipboard
inline operator fun div(other: Byte): Int
operator external fun div(other: Int): Int
inline operator fun div(other: Long): Long
inline operator fun div(other: Short): Int

Divides this value by the other value, truncating the result to an integer that is closer to zero.

inline operator fun div(other: Double): Double
inline operator fun div(other: Float): Float

Divides this value by the other value.

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
fun equals(other: Int): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
inc
Link copied to clipboard
operator external fun inc(): Int

Increments this value.

inv
Link copied to clipboard
external fun inv(): Int

Inverts the bits in this value.

minus
Link copied to clipboard
inline operator fun minus(other: Byte): Int
inline operator fun minus(other: Double): Double
inline operator fun minus(other: Float): Float
operator external fun minus(other: Int): Int
inline operator fun minus(other: Long): Long
inline operator fun minus(other: Short): Int

Subtracts the other value from this value.

or
Link copied to clipboard
infix external fun or(other: Int): Int

Performs a bitwise OR operation between the two values.

plus
Link copied to clipboard
inline operator fun plus(other: Byte): Int
inline operator fun plus(other: Double): Double
inline operator fun plus(other: Float): Float
operator external fun plus(other: Int): Int
inline operator fun plus(other: Long): Long
inline operator fun plus(other: Short): Int

Adds the other value to this value.

rangeTo
Link copied to clipboard
operator fun rangeTo(other: Byte): IntRange
operator fun rangeTo(other: Int): IntRange
operator fun rangeTo(other: Long): LongRange
operator fun rangeTo(other: Short): IntRange

Creates a range from this value to the specified other value.

rem
Link copied to clipboard
inline operator fun rem(other: Byte): Int
inline operator fun rem(other: Double): Double
inline operator fun rem(other: Float): Float
operator external fun rem(other: Int): Int
inline operator fun rem(other: Long): Long
inline operator fun rem(other: Short): Int

Calculates the remainder of truncating division of this value by the other value.

shl
Link copied to clipboard
infix external fun shl(bitCount: Int): Int

Shifts this value left by the bitCount number of bits.

shr
Link copied to clipboard
infix external fun shr(bitCount: Int): Int

Shifts this value right by the bitCount number of bits, filling the leftmost bits with copies of the sign bit.

times
Link copied to clipboard
inline operator fun times(other: Byte): Int
inline operator fun times(other: Double): Double
inline operator fun times(other: Float): Float
operator external fun times(other: Int): Int
inline operator fun times(other: Long): Long
inline operator fun times(other: Short): Int

Multiplies this value by the other value.

toByte
Link copied to clipboard
open external override fun toByte(): Byte

Converts this Int value to Byte.

toChar
Link copied to clipboard
open external override fun toChar(): Char

Converts this Int value to Char.

toDouble
Link copied to clipboard
open external override fun toDouble(): Double

Converts this Int value to Double.

toFloat
Link copied to clipboard
open external override fun toFloat(): Float

Converts this Int value to Float.

toInt
Link copied to clipboard
open inline override fun toInt(): Int

Returns this value.

toLong
Link copied to clipboard
open external override fun toLong(): Long

Converts this Int value to Long.

toShort
Link copied to clipboard
open external override fun toShort(): Short

Converts this Int value to Short.

toString
Link copied to clipboard
open external override fun toString(): String
unaryMinus
Link copied to clipboard
operator external fun unaryMinus(): Int

Returns the negative of this value.

unaryPlus
Link copied to clipboard
operator external fun unaryPlus(): Int

Returns this value.

ushr
Link copied to clipboard
infix external fun ushr(bitCount: Int): Int

Shifts this value right by the bitCount number of bits, filling the leftmost bits with zeros.

xor
Link copied to clipboard
infix external fun xor(other: Int): Int

Performs a bitwise XOR operation between the two values.

Extensions

absoluteValue
Link copied to clipboard
expect val Int.absoluteValue: Int

Returns the absolute value of this value.

actual val Int.absoluteValue: Int

Returns the absolute value of this value.

actual val Int.absoluteValue: Int

Returns the absolute value of this value.

actual val Int.absoluteValue: Int

Returns the absolute value of this value.

coerceAtLeast
Link copied to clipboard
fun Int.coerceAtLeast(minimumValue: Int): Int

Ensures that this value is not less than the specified minimumValue.

coerceAtMost
Link copied to clipboard
fun Int.coerceAtMost(maximumValue: Int): Int

Ensures that this value is not greater than the specified maximumValue.

coerceIn
Link copied to clipboard
fun Int.coerceIn(minimumValue: Int, maximumValue: Int): Int

Ensures that this value lies in the specified range minimumValue..maximumValue.

fun Int.coerceIn(range: ClosedRange<Int>): Int

Ensures that this value lies in the specified range.

convert
Link copied to clipboard
inline external fun <R : Any> Int.convert(): R
countLeadingZeroBits
Link copied to clipboard
expect fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

actual inline fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

actual inline fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

actual fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

countOneBits
Link copied to clipboard
expect fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

actual inline fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

actual fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

actual external fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

countTrailingZeroBits
Link copied to clipboard
expect fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

actual inline fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

actual fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

actual fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

days
Link copied to clipboard
val Int.days: Duration

Returns a Duration equal to this Int number of days.

digitToChar
Link copied to clipboard
fun Int.digitToChar(): Char

Returns the Char that represents this decimal digit. Throws an exception if this value is not in the range 0..9.

fun Int.digitToChar(radix: Int): Char

Returns the Char that represents this numeric digit value in the specified radix. Throws an exception if the radix is not in the range 2..36 or if this value is not in the range 0 until radix.

downTo
Link copied to clipboard
infix fun Int.downTo(to: Byte): IntProgression
infix fun Int.downTo(to: Int): IntProgression
infix fun Int.downTo(to: Long): LongProgression
infix fun Int.downTo(to: Short): IntProgression

Returns a progression from this value down to the specified to value with the step -1.

floorDiv
Link copied to clipboard
inline fun Int.floorDiv(other: Byte): Int
inline fun Int.floorDiv(other: Short): Int
inline fun Int.floorDiv(other: Int): Int
inline fun Int.floorDiv(other: Long): Long

Divides this value by the other value, flooring the result to an integer that is closer to negative infinity.

hours
Link copied to clipboard
val Int.hours: Duration

Returns a Duration equal to this Int number of hours.

microseconds
Link copied to clipboard
val Int.microseconds: Duration

Returns a Duration equal to this Int number of microseconds.

milliseconds
Link copied to clipboard
val Int.milliseconds: Duration

Returns a Duration equal to this Int number of milliseconds.

minutes
Link copied to clipboard
val Int.minutes: Duration

Returns a Duration equal to this Int number of minutes.

mod
Link copied to clipboard
inline fun Int.mod(other: Byte): Byte
inline fun Int.mod(other: Short): Short
inline fun Int.mod(other: Int): Int
inline fun Int.mod(other: Long): Long

Calculates the remainder of flooring division of this value by the other value.

nanoseconds
Link copied to clipboard
val Int.nanoseconds: Duration

Returns a Duration equal to this Int number of nanoseconds.

rotateLeft
Link copied to clipboard
expect fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

@ExperimentalStdlibApi
actual inline fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

@ExperimentalStdlibApi
actual fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

@ExperimentalStdlibApi
actual fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

rotateRight
Link copied to clipboard
expect fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

@ExperimentalStdlibApi
actual inline fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

@ExperimentalStdlibApi
actual fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

@ExperimentalStdlibApi
actual fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

seconds
Link copied to clipboard
val Int.seconds: Duration

Returns a Duration equal to this Int number of seconds.

sign
Link copied to clipboard
expect val Int.sign: Int

Returns the sign of this value:

actual val Int.sign: Int

Returns the sign of this value:

actual val Int.sign: Int

Returns the sign of this value:

actual val Int.sign: Int

Returns the sign of this value:

takeHighestOneBit
Link copied to clipboard
expect fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

actual inline fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

actual fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

actual fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

takeLowestOneBit
Link copied to clipboard
expect fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

actual inline fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

actual fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

actual fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

times
Link copied to clipboard
inline operator fun Int.times(duration: Duration): Duration

Returns a duration whose value is the specified duration value multiplied by this number.

toBigDecimal
Link copied to clipboard
inline fun Int.toBigDecimal(): BigDecimal
inline fun Int.toBigDecimal(mathContext: MathContext): BigDecimal

Returns the value of this Int number as a BigDecimal.

toBigInteger
Link copied to clipboard
inline fun Int.toBigInteger(): BigInteger

Returns the value of this Int number as a BigInteger.

toDuration
Link copied to clipboard
fun Int.toDuration(unit: DurationUnit): Duration

Returns a Duration equal to this Int number of the specified unit.

toString
Link copied to clipboard
expect fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

actual inline fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

actual fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

actual inline fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

toUByte
Link copied to clipboard
inline fun Int.toUByte(): UByte

Converts this Int value to UByte.

toUInt
Link copied to clipboard
inline fun Int.toUInt(): UInt

Converts this Int value to UInt.

toULong
Link copied to clipboard
inline fun Int.toULong(): ULong

Converts this Int value to ULong.

toUShort
Link copied to clipboard
inline fun Int.toUShort(): UShort

Converts this Int value to UShort.

until
Link copied to clipboard
infix fun Int.until(to: Byte): IntRange
infix fun Int.until(to: Int): IntRange
infix fun Int.until(to: Long): LongRange
infix fun Int.until(to: Short): IntRange

Returns a range from this value up to but excluding the specified to value.